Fix formatting of PR refs in release notes#23434
Open
mikeCRL wants to merge 3 commits into
Open
Conversation
Fix issue references that were being interpreted as markdown headings by increasing their indentation to match preceding continuation text. Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
mikeCRL
changed the title
Add backslash escaping to issue references that would otherwise be interpreted as markdown headings due to starting with #. Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
Move all issue references to be inline at the end of simple single-paragraph bullets instead of on their own lines, preventing them from being interpreted as H1 headings. This fixes 401 instances across 43 release note files. Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>
mikeCRL
changed the title
mikeCRL
changed the title
Contributor
|
@mikeCRL is this a regression or is it something that was there from the beginning that started causing problems now? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixed instances of PR references being interpreted as H1 headings.
Since #23301, instances of continuation text (multi-paragraph bullets) followed by an PR reference on its own line, would have that reference and all others in the section (until the next intentional heading) interpreted as H1s.
This may have only affected sections of 3 releases' notes, but to be thorough/consistent, I made the following changes across the board:
\to the reference.Example changes:
For single-line bullets:
Before:
After:
For continuation bullets:
Before:
After:
Example of the bug
From https://www.cockroachlabs.com/docs/releases/v25.2#v25-2-3: